home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1997 February / EnigmA AMIGA RUN 15 (1997)(G.R. Edizioni)(IT)[!][issue 1997-02][PLANET CD V].iso / progs / editor / frexxed / bin / etags.lha / ETags.README < prev    next >
Text File  |  1995-01-30  |  3KB  |  64 lines
  1. This file is written and administrated by Daniel Stenberg. Last modified on
  2. Mon Jan 30 1995.
  3.  
  4. ETags is Copyright (C) 1984, 1987, 1988, 1989, 1992 Free Software Foundation,
  5. Inc. and Ken Arnold
  6.  
  7. This version of ETags has been modified, enhanced and ANSIfied by Daniel
  8. Stenberg.
  9.  
  10.                     ETags
  11.                     ~~~~~
  12.  
  13.  What is ETags?
  14.  ~~~~~~~~~~~~~~
  15.  Etags is a program, originally made by Ken Arnold, included in the GNU Emacs
  16. package. It scans programs and extracts programming language dependent 'tags'
  17. from them. Etags store the tags in a file together with references to the files
  18. in which the 'tags' were found.
  19.  
  20.  What 'tags' are extracted?
  21.  ~~~~~~~~~~~~~~~~~~~~~~~~~~
  22.  'Tags' in this case is in C programs: function defines, structure definitions,
  23. enum variables, defined indentifiers and such. It extracts similar 'tags'
  24. from programs written in C++, Assembler, Pascal, Fortran, Prolog, Scheme, LISP
  25. and TeX/LaTeX.
  26.  
  27.  How are the tags stored?
  28.  ~~~~~~~~~~~~~~~~~~~~~~~~
  29.  The tags are by default stored in Emacs format. That special format is
  30. understood and interpreted by the Emacs LISP script etags.el. To make etags
  31. output a format which is understood by FrexxEd, the command line option '-eX'
  32. should be used and the output redirected to a file (preferably called 'ETAGS').
  33.  
  34.  How do I run 'etags'?
  35.  ~~~~~~~~~~~~~~~~~~~~~
  36.  To make the most verbose list to use within FrexxEd, enter something similar
  37. to the following in your project directory:
  38. 'etags >ETAGS -eTX #?.c'
  39.  
  40.  How are the tags used?
  41.  ~~~~~~~~~~~~~~~~~~~~~~
  42.  The supplied FPL program 'ETags.FPL' should be executed (put it in your
  43. User.FPL if you'd like it at every FrexxEd startup). When done, pressing the
  44. key sequence "alt ." will bring up a requester with all tags of your project.
  45. "alt shift ." will immediately and silently jump to the origin source and line
  46. of the tag under the cursor (ie, if your cursor is placed on a function call,
  47. "alt shift ." will make FrexxEd jump to the place where that function is
  48. defined).
  49.  
  50.  How does it work?
  51.  ~~~~~~~~~~~~~~~~~
  52.  FrexxEd will use the generated output file to search for the tags and their
  53. origins. If the output file isn't already in memory, it'll load it first. If it
  54. can't find the file, it'll ask the user to tell which file to use. When the
  55. requested tag is found, the script will switch to the tag's origin source (it
  56. loads it if it has to) and searches for the line were the tag origins. The
  57. search is done to enable changes to be done to the source files after the tag
  58. file was generated. If the pattern wasn't found, the script will place the
  59. cursor on the exact line number where the tag was reported to be at.
  60.  
  61.  How to get tags from other languages?
  62.  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  63.  Write a parser and add it to the etags.c source code. The source is written
  64. to enable function sharing between a lot of parsers.